home *** CD-ROM | disk | FTP | other *** search
/ Game Programming in C++ - Start to Finish / GameProgrammingS.iso / Peon / PeonSDK-Win32-1.0.0.exe / {app} / PeonMain / include / CEGUI / elements / CEGUIMenuItemProperties.h < prev    next >
Encoding:
C/C++ Source or Header  |  2005-09-07  |  4.3 KB  |  165 lines
  1. /************************************************************************
  2.     filename:     CEGUIMenuItemProperties.h
  3.     created:    8/4/2005
  4.     author:        Tomas Lindquist Olsen (based on code by Paul D Turner)
  5. *************************************************************************/
  6. /*************************************************************************
  7.     Crazy Eddie's GUI System (http://www.cegui.org.uk)
  8.     Copyright (C)2004 - 2005 Paul D Turner (paul@cegui.org.uk)
  9.  
  10.     This library is free software; you can redistribute it and/or
  11.     modify it under the terms of the GNU Lesser General Public
  12.     License as published by the Free Software Foundation; either
  13.     version 2.1 of the License, or (at your option) any later version.
  14.  
  15.     This library is distributed in the hope that it will be useful,
  16.     but WITHOUT ANY WARRANTY; without even the implied warranty of
  17.     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18.     Lesser General Public License for more details.
  19.  
  20.     You should have received a copy of the GNU Lesser General Public
  21.     License along with this library; if not, write to the Free Software
  22.     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  23. *************************************************************************/
  24. #ifndef _CEGUIMenuItemProperties_h_
  25. #define _CEGUIMenuItemProperties_h_
  26.  
  27. #include "CEGUIProperty.h"
  28.  
  29. // Start of CEGUI namespace section
  30. namespace CEGUI
  31. {
  32. // Start of MenuItemProperties namespace section
  33. namespace MenuItemProperties
  34. {
  35.  
  36. /*!
  37. \brief
  38.     Property to access the hover colour of the item.
  39.  
  40.     \par Usage:
  41.         - Name: HoverColour
  42.         - Format: "[aarrggbb]".
  43.  
  44.     \par Where:
  45.         - [aarrggbb] represents the hover colour of the item.
  46. */
  47. class HoverColour : public Property
  48. {
  49. public:
  50.     HoverColour() : Property(
  51.         "HoverColour",
  52.         "Property to get/set the hover colour of the item.  Value is a colour.",
  53.         "00FFFFFF")
  54.     {}
  55.  
  56.     String    get(const PropertyReceiver* receiver) const;
  57.     void    set(PropertyReceiver* receiver, const String& value);
  58. };
  59.  
  60.  
  61. /*!
  62. \brief
  63.     Property to access the pushed colour of the item.
  64.  
  65.     \par Usage:
  66.         - Name: PushedColour
  67.         - Format: "[aarrggbb]".
  68.  
  69.     \par Where:
  70.         - [aarrggbb] represents the pushed colour of the item.
  71. */
  72. class PushedColour : public Property
  73. {
  74. public:
  75.     PushedColour() : Property(
  76.         "PushedColour",
  77.         "Property to get/set the pushed colour of the item.  Value is a colour.",
  78.         "00FFFFFF")
  79.     {}
  80.  
  81.     String    get(const PropertyReceiver* receiver) const;
  82.     void    set(PropertyReceiver* receiver, const String& value);
  83. };
  84.  
  85.  
  86. /*!
  87. \brief
  88.     Property to access the opened colour of the item.
  89.  
  90.     \par Usage:
  91.         - Name: OpenedColour
  92.         - Format: "[aarrggbb]".
  93.  
  94.     \par Where:
  95.         - [aarrggbb] represents the opened colour of the item.
  96. */
  97. class OpenedColour : public Property
  98. {
  99. public:
  100.     OpenedColour() : Property(
  101.         "OpenedColour",
  102.         "Property to get/set the opened colour of the item.  Value is a colour.",
  103.         "00EFEFEF")
  104.     {}
  105.  
  106.     String    get(const PropertyReceiver* receiver) const;
  107.     void    set(PropertyReceiver* receiver, const String& value);
  108. };
  109.  
  110.  
  111. /*!
  112. \brief
  113.     Property to access the normal text colour of the item.
  114.  
  115.     \par Usage:
  116.         - Name: NormalTextColour
  117.         - Format: "[aarrggbb]".
  118.  
  119.     \par Where:
  120.         - [aarrggbb] represents the normal text colour of the item.
  121. */
  122. class NormalTextColour : public Property
  123. {
  124. public:
  125.     NormalTextColour() : Property(
  126.         "NormalTextColour",
  127.         "Property to get/set the normal text colour of the item.  Value is a colour.",
  128.         "00FFFFFF")
  129.     {}
  130.  
  131.     String    get(const PropertyReceiver* receiver) const;
  132.     void    set(PropertyReceiver* receiver, const String& value);
  133. };
  134.  
  135.  
  136. /*!
  137. \brief
  138.     Property to access the disabled text colour of the item.
  139.  
  140.     \par Usage:
  141.         - Name: DisabledTextColour
  142.         - Format: "[aarrggbb]".
  143.  
  144.     \par Where:
  145.         - [aarrggbb] represents the disabled text colour of the item.
  146. */
  147. class DisabledTextColour : public Property
  148. {
  149. public:
  150.     DisabledTextColour() : Property(
  151.         "DisabledTextColour",
  152.         "Property to get/set the disabled text colour of the item.  Value is a colour.",
  153.         "007F7F7F")
  154.     {}
  155.  
  156.     String    get(const PropertyReceiver* receiver) const;
  157.     void    set(PropertyReceiver* receiver, const String& value);
  158. };
  159.  
  160.  
  161. } // End of  MenuItemProperties namespace section
  162. } // End of  CEGUI namespace section
  163.  
  164. #endif    // end of guard _CEGUIMenuItemProperties_h_
  165.